PR 4/7 in the Notification SDK stack. Rebased onto main (foundation #512, mark-read #513, and delete #514 are now merged); this branch is a single squashed commit.

Adds the Subscriptions service alongside the existing Notifications service. Both live under @uipath/uipath-typescript/notifications as discrete classes (no shared state). This PR ships the 3 read methods + subscription model foundation.

All three methods are tagged @internal (the NotificationService scope is internal), so no docs/oauth-scopes.md or mkdocs.yml nav entries are added — matching #512–#514.

Methods Added

Endpoints Called

Response Modeling

getAll() and getPublishers() populate genuinely different field sets (verified against the backend GetUserSubscriptionHandlers vs GetPublisherDetailsHandler), so each has its own explicit response type:

• getAll() → SubscriptionGetResponse — full per-publisher, per-topic, per-channel subscription state (SubscriptionPublisher[]).
• getPublishers() → SubscriptionGetPublishersResponse — discovery-only catalogue (SubscriptionPublisherBase[]) carrying only identity fields + topic list, no subscription state.
• The full SubscriptionPublisher / SubscriptionTopic extend the base shapes SubscriptionPublisherBase / SubscriptionTopicBase, so the discovery fields are declared once. Accessing state-only fields (isSubscribed, modes, isUserOptin, …) on a getPublishers() result is a compile error, steering callers to getAll().
• getSupportedChannels() returns Email/Slack/Teams with isEnabled. InApp is implicitly always available and not included in the response.
• Adds the NotificationMode delivery-channel enum (InApp/Email/Slack/Teams) to notifications.types.ts, shared by the subscription channel/mode shapes.
• All three methods carry @track(...) telemetry decorators and forward the acting tenantId as the first argument.

Example Usage

import { Subscriptions, NotificationMode } from '@uipath/uipath-typescript/notifications';

const subscriptions = new Subscriptions(sdk);
const tenantId = '<tenant-guid>';

// Full subscription state
const { publishers } = await subscriptions.getAll(tenantId);

// Filter to specific publishers
const orchestrator = await subscriptions.getAll(tenantId, {
  publishers: ['Orchestrator', 'Actions'],
});

// Discovery (no state) — SubscriptionPublisherBase[]
const { publishers: catalogue } = await subscriptions.getPublishers(tenantId);

// Channel availability — InApp is always implicit and not listed
const { channels } = await subscriptions.getSupportedChannels(tenantId);
const slack = channels.find(c => c.name === NotificationMode.Slack);

Sample SDK Responses

{
  "channels": [
    { "name": "Email", "isEnabled": true },
    { "name": "Slack", "isEnabled": false },
    { "name": "Teams", "isEnabled": false }
  ]
}

{
  "publishers": [
    {
      "id": "3b5c8128-8af0-46ec-eb1d-08da31909e0f",
      "name": "Apps",
      "displayName": "Apps",
      "topics": [
        { "id": "b3f9b2fd-122f-4d40-3d88-08da31909e1a", "name": "Apps.Shared", "displayName": "Apps Shared", "description": "Apps is Shared", "group": "Apps Activities" },
        { "id": "7a647eb5-381e-4712-55de-08db6be7681e", "name": "Apps.Cloned", "displayName": "App Duplicated", "description": "App is Duplicated", "group": "Apps Activities" }
      ]
    }
  ]
}

{
  "publishers": [
    {
      "id": "3b5c8128-8af0-46ec-eb1d-08da31909e0f",
      "name": "Apps",
      "displayName": "Apps",
      "isUserOptin": true,
      "modes": [
        { "name": "InApp", "isActive": true },
        { "name": "Email", "isActive": true }
      ],
      "topics": [
        {
          "id": "b3f9b2fd-122f-4d40-3d88-08da31909e1a",
          "name": "Apps.Shared",
          "category": "Success",
          "isSubscribed": true,
          "isMandatory": false,
          "modes": [
            { "name": "InApp", "isSubscribed": true, "isSubscribedByDefault": true },
            { "name": "Email", "isSubscribed": true, "isSubscribedByDefault": true }
          ]
        }
      ]
    }
  ]
}

Verification

Files

PR Stack

🤖 Generated with Claude Code